Google Sheets App Scope
AutomatR.GoogleSheets.Activities.GoogleSheetsAppScope
The "Google Sheets App Scope" activity in AutomatR allows you to access a Google Sheet user account based on API Auth keys or OAuth mechanism. This activity serves as a container for other Google Sheets activities, providing the necessary authentication and authorization to perform actions on a specified Google Sheet.
Properties
| Name | Description |
|---|---|
| Input | |
| Application Name | Specifies the name of the Google Sheet on which the user needs to work. String variables containing the Google Sheet name. |
| Spread Sheet ID | Specifies the encrypted format of the spreadsheet ID (e.g., captured from the Google Sheets URL). String variables containing the spreadsheet ID. |
| Sheet Name | Specifies the name of the spreadsheet on which the user needs to work. String variables containing the spreadsheet name. |
| Miscellaneous | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Google Sheets App Scope" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Refresh Token | Allows browsing for the refresh token and selecting the email ID associated with your Google Sheets account. This enables the capture of the API token required to access your Google Sheets account. |
| Client ID | Specifies the client ID for your Google Sheets user's account. String variables containing the client ID. |
| Client Secret Key | Specifies the client secret key for your Google Sheets user's account. String variables containing the client secret key. |
| Output | |
| Google Sheet Scope | Outputs the authenticated SheetsService object, which can be used in subsequent Google Sheets activities. Variables of type SheetsService to store the authenticated service. |
Note: The "Google Sheets App Scope" activity requires either the combination of Client ID and Client Secret Key or the Refresh Token. Please provide Client ID & Client Secret Key or only Refresh Token.
How to use:
- Drag and drop the "Google Sheets App Scope" activity onto the workflow.
- Configure the properties by specifying the Application Name, Spread Sheet ID, Sheet Name, and optional settings like Delay, Refresh Token, Client ID, and Client Secret Key.
- Drop other Google Sheets activities into the "Google Sheets App Scope" container to perform specific actions on the specified Google Sheet.
- Execute the workflow to perform the desired actions on the Google Sheet.
Example: Consider an example where the "Google Sheets App Scope" activity is used to access a Google Sheet named "Expense Sheet" with the spreadsheet ID "abc123456def" and the sheet name "Monthly Expenses":
Google Sheets App Scope:
Application Name: "Expense Sheet"
Spread Sheet ID: "abc123456def"
Sheet Name: "Monthly Expenses"
Delay: 1
Refresh Token: {your_refresh_token}
Client ID: {your_client_id}
Client Secret Key: {your_client_secret}
Google Sheet Scope: googleSheetsService
In this example, the activity authenticates the user, validates the specified Google Sheet, and provides the authenticated service (googleSheetsService) for use in subsequent Google Sheets activities within the scope.